Перейти к основному содержимому

sm.scrapcomputers.config

`sm.scrapcomputers.config" позволяет настраивать параметры мода в мире. Например, устанавливать значения конфигурации или создавать новые конфигурации.

Поля

ТипИмяОписание
stringkeyКлюч, используемый в sm.storage. Используйте его, если вы хотите получить доступ к Данным конфигураций ScrapComputers напрямую.

Структуры​

Configuration​

Конфигурация ScrapComputers.

Поля​

  • id [ string ] Id конфигурации. Рекомендуется использовать этот формат названия, чтобы не вызывать конфликтов: [ИМЯ_МОДА].[ИМЯ_КОМПОНЕНТА].[ИМЯ_КОНФИГУРАЦИИ]
  • name [ string ] Имя конфигурации.
  • description [ string ] Описание конфигурации.
  • selectedOption [ integer ] Текущая выбранная опция конфигурации.
  • hostOnly [ boolean ] Если настройка конфигурации доступна только для хоста.
  • options [ string ][] Список опций конфигурации.

Функции​

createDefaultConfigs​

sm.scrapcomputers.config.createDefaultConfigs( onlyDefaultConfigs )

Создает конфигурацию по умолчанию.

Аргументы:

  • onlyDefaultConfigs [ boolean? ] True, если вы не хотите, чтобы конфигурации, добавленные из аддонов, добавлялись в эту конфигурацию. По умолчанию — false

Возвращает:

  • [ Configuration[] ] Сгенерированные конфигурации.

initConfig​

sm.scrapcomputers.config.initConfig()

Server-Only

Инициализирует систему конфигурации. Обычно вам не нужно вызывать эту функцию, поскольку она вызывается при загрузке ScrapComputers

nameToId​

sm.scrapcomputers.config.nameToId( name )

Server-Only
Нужна инициализация

Преобразует имя конфигурации в её id.

Аргументы:

  • name [ string ] Имя конфигурации

Возвращает:

  • id [ string ] Id конфигурации

getConfigByIndex​

sm.scrapcomputers.config.getConfigByIndex( index )

Server-Only
Нужна инициализация

Получает конфигурацию по индексу (не по id!) Если конфигурация не найдена, выдаст ошибку.

Аргументы:

  • index [ integer ] Индекс для поиска.

Возвращает:

  • [ Configuration ] Конфигурация, если найдена.

getTotalConfigurations​

sm.scrapcomputers.config.getTotalConfigurations()

Server-Only
Нужна инициализация

Получает количество конфигураций.

Возвращает:

  • [ integer ] Количество конфигураций.

setConfig​

sm.scrapcomputers.config.setConfig( id, selectedOption )

Server-Only
Нужна инициализация

Обновляет значение конфигурации.

Аргументы:

  • id [ string ] Id конфигурации.
  • selectedOption [ integer ] Новое выбранное свойство для конфигурации.

resetConfiguration​

sm.scrapcomputers.config.resetConfiguration()

Server-Only
Нужна инициализация

Сбрасывает конфигурацию обратно до значения по умолчанию.

saveConfig​

sm.scrapcomputers.config.saveConfig()

Server-Only
Нужна инициализация

Сохраняет текущую конфигурацию в мир.

createConfig​

sm.scrapcomputers.config.createConfig( id, name, description, hostOnly, options )

Server-Only
Нужна инициализация

Создает новую конфигурацию

Аргументы:

  • id [ string ] Id конфигурации. Рекомендуется использовать этот формат названия, чтобы не вызывать конфликтов: [ИМЯ_МОДА].[ИМЯ_КОМПОНЕНТА].[ИМЯ_КОНФИГУРАЦИИ]
  • name [ string ] Имя конфигурации.
  • description [ string ] Описание конфигурации.
  • hostOnly [ boolean ] Если настройка конфигурации доступна только для хоста.
  • options [ string ][] Список опций конфигурации.

getConfig​

sm.scrapcomputers.config.getConfig( id )

Server-Only
Нужна инициализация

Получает конфигурацию по id. Получит ошибку, если конфигурация не найдена.

Аргументы:

  • id [ string ] Id конфигурации

Возвращает:

configExists​

sm.scrapcomputers.config.configExists( id )

Server-Only
Нужна инициализация

Возвращает true, если конфигурация с таким id существует.

Аргументы:

  • id [ string ] Id конфигурации.

Возвращает:

  • [ boolean ] True, если конфигурация найдена.